Book Contents

caption element

The caption element contains and describes the text that appears on a button or state to tell the operator something about the object's purpose or state.

Caption elements have the following attributes:

  • backColor
  • backStyle
  • fontFamily
  • fontSize
  • bold
  • underline
  • italic
  • strikethrough
  • caption
  • alignment
  • blink
  • color
  • wordWrap

The following elements have caption elements:

  • Button graphic object elements (without states): acknowledgeAlarmButton, acknowledgeAllAlarmsButton, alarmStatusModeButton, clearAlarmBannerButton, clearAlarmHistoryButton, closeButton, diagnosticsClearButton, diagnosticsClearAllButton, displayPrintButton, gotoButton, gotoConfigureModeButton, informationAckButton, loginButton, logoutButton, macroButton, printAlarmHistory, printAlarmStatus, rampButton, resetAlarmStatusButton, returnToButton, shutdownButton, silenceAlarmsButton, sortAlarmsButton, trendNextPenButton, trendPauseButton
  • Key button graphic object elements: backspaceKey, endKey, enterKey, homeKey, moveDownKey, moveLeftKey, moveRightKey, moveUpKey, pageDownKey, pageUpKey
  • Numeric and string object elements: numericInputEnable, stringInputEnable
  • State elements

    For objects with states, the caption is a nested element within the state element.

See also

caption element attributes